<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Playbook - SnapshotWaiter</title>
    <link rel="stylesheet" type="text/css" href="https://playbook-ui.github.io/playbook-ios/all.css" media="all" />
</head>
<body>
    <header>
        <a href="https://playbook-ui.github.io/playbook-ios">
            <strong>
                Playbook
            </strong>
            <span>Documentation</span>
        </a>
    </header>

    <!--
    <form class="search">
        <input type="search" placeholder="Search" />
    </form>
    -->

    <nav>
        <div class="wrapper">
            <h2>On This Page</h2>
            <ol><li><a href="#initializers">Initializers</a><ul><li class="initializer"><a href="#snapshotwaiter.init()">init()</a></li></ul></li><li><a href="#properties">Properties</a><ul><li class="variable"><a href="#snapshotwaiter.iswaiting">is​Waiting</a></li></ul></li><li><a href="#methods">Methods</a><ul><li class="function"><a href="#snapshotwaiter.wait()">wait()</a></li><li class="function"><a href="#snapshotwaiter.wait(until:)">wait(until:​)</a></li><li class="function"><a href="#snapshotwaiter.fulfill()">fulfill()</a></li></ul></li></ol>
        </div>
    </nav>

    <main>
        <article>
            <h1>
    <small>Class</small>
    <code class="name">Snapshot​Waiter</code>
</h1>

<div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="attribute">final</span> <span class="keyword">class</span> <span class="type">SnapshotWaiter</span>  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>A snapshot timing manager to wait and fulfillment for the scenario
content to be rendered.</p>

</div>

    <section id="initializers">
        <h2>Initializers</h2>

        <div role="article" class="initializer" id="snapshotwaiter.init()">
    <h3>
        <code><a href="#snapshotwaiter.init()">init()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">init</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Initialize a new waiter.</p>

</div>
</div>
    </section>
    <section id="properties">
        <h2>Properties</h2>

        <div role="article" class="variable" id="snapshotwaiter.iswaiting">
    <h3>
        <code><a href="#snapshotwaiter.iswaiting">is​Waiting</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">var</span> <span class="variable">isWaiting</span>: <span class="type">Bool</span>  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Specifies whether currently waiting.</p>

</div>
</div>
    </section>
    <section id="methods">
        <h2>Methods</h2>

        <div role="article" class="function" id="snapshotwaiter.wait()">
    <h3>
        <code><a href="#snapshotwaiter.wait()">wait()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">wait</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Wait for the snapshot for 10 seconds from now.</p>

</div>
</div>
<div role="article" class="function" id="snapshotwaiter.wait(until:)">
    <h3>
        <code><a href="#snapshotwaiter.wait(until:)">wait(until:​)</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">wait</span>(<span class="variable">until</span> <span class="variable">timeout</span>: <span class="type">DispatchTime</span>)  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Wait for the snapshot until the specified timeout period.</p>

</div>
<h4>Parameters</h4>

<table class="parameters">
  <thead hidden>
  <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
  </tr>
  </thead>
  <tbody>
    <tr>
    <th>timeout</th>
    <td><code class="type">Dispatch​Time</code></td>
    <td><p>A timeout period for waiting the snapshot.</p>
</td>
</tr>
  </tbody>
</table>
</div>
<div role="article" class="function" id="snapshotwaiter.fulfill()">
    <h3>
        <code><a href="#snapshotwaiter.fulfill()">fulfill()</a></code>
    </h3>
    <div class="declaration">
<pre class="highlight"><code><html><body><span class="keyword">public</span> <span class="keyword">func</span> <span class="function">fulfill</span>()  </body></html></code></pre>
</div>
<div class="summary" role="doc-abstract">
    <p>Complete waiting for the snapshot.</p>

</div>
</div>
    </section>



        </article>
    </main>

    <footer>
        <p>
    Generated on <time datetime="2021-08-25T19:01:53+0900">August 25, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>.
</p>
    </footer>
</body>
</html>
